Modify Customer Package

This API is used to update the details of a single Package in the system.

NOTE: Request should contain only elements which require modification. Empty elements denote overridden of the existing value with a NULL value.

Method	Path
PATCH	/api/v2/customer/{id}/package/{id}

Eligibility

The Requestor is eligible to request modifications on his own Packages. It is not eligible to modify any other Package.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
description	String	O	Package description.
nestedOffers	UUID	O	Array of offer IDs. Changing the order of the offer IDs will change the consumption priority. Changing this attribute is not allowed if the package has been attached at least once to a SIM. The system provides this indication in the Get Customer Package API via the ‘isEverUsed’ flag.
eligibleSubAccountIds	String	O	Array of sub-account UUIDs. Specified sub-accounts are eligible to view and manage (attach/detach) this package as part of the self-service feature. If sent empty, none of the customer’s sub-accounts are eligible for this package. 'ALL' keyword (ENUM) means all the customer’s sub-accounts are eligible for this package. Note: Removing an existing sub-account that has already attached a SIM to this package will eliminate the ability of the sub-account to detach the SIM from this package using the self-service mode.

Parameter

Type

M/O/CM

Description

description

String

Package description.

nestedOffers

UUID

Array of offer IDs. Changing the order of the offer IDs will change the consumption priority. Changing this attribute is not allowed if the package has been attached at least once to a SIM. The system provides this indication in the Get Customer Package API via the ‘isEverUsed’ flag.

eligibleSubAccountIds

String

Array of sub-account UUIDs. Specified sub-accounts are eligible to view and manage (attach/detach) this package as part of the self-service feature. If sent empty, none of the customer’s sub-accounts are eligible for this package. 'ALL' keyword (ENUM) means all the customer’s sub-accounts are eligible for this package.

Note: Removing an existing sub-account that has already attached a SIM to this package will eliminate the ability of the sub-account to detach the SIM from this package using the self-service mode.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure detailed description.
content	Object	O	Array of main response body objects. Displayed when an API call is successful. For a failure, it will be empty.
pageable	Object	O	Paging information object. Displayed when an API call is successful. For a failure, it will be empty.

Content

Parameter	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status, whether in progress, successful, or failed.

Pageable

Parameter	Type	M/O/CM	Description
page	Numeric	M	Page number.
size	Numeric	M	Page size. Number of requested elements per page.
totalPages	Numeric	M	Total amount of available pages per requested page size.
totalElements	Numeric	M	Total amount of retrieved elements.

Error Codes

In addition to the general success and failure codes, the following error codes are possible:

Code	Message
GLOBAL_1001	Service unavailable. Please try again.
CUSTOMER_1002	Customer does not exist.
CUSTOMER_1051	Unknown package id.

Examples

Request Body

Copy

{  
  "eligibleSubAccountIds": [
    "ff74dca6-8e7f-4b85-a42b-13860913b371",
    "ceb892d2-f24b-4007-bf81-999fe75cb635"
  ]
}

Response Body Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b371"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body Failure NAK

{

"errorCode": "GLOBAL_1001",

"errorMessage": "Service unavailable. Please try again",

"content": "",

"pageable": ""

}